NomGridCtrl Methods

The CygNet GCM Nomination Grid Control object contains the following methods:

AboutBox

The AboutBox method displays an About dialog box for the control.

Syntax

AboutBox()

Example

The following examples launch an About dialog box for the control.

Sub ShowAboutBox()
 
    <Object>.AboutBox
 
End Sub

Sub ButtonTool_EventClick()

    Dim This : Set This = ButtonTool
    <Object>.AboutBox
 
End Sub

ApplyUnitSet

The ApplyUnitSet method changes the current units to a predefined set.

Syntax

ApplyUnitsSet(nUnitsSet As Integer)

Parameters

Example

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
Sub cboDisplayUnitSet_EventChange()
    Dim This : Set This = cboDisplayUnitSet
    Dim iSelection
    iSelection = this.Selection
     
    'NomGridCtrl1.StopAllActivity
     
    If iSelection = 0 Then
        NomGridCtrl1.ApplyUnitsSet 0
    Elseif iSelection = 1 Then
        NomGridCtrl1.ApplyUnitsSet 1
    Else
        msgbox "Invalid selection of " & iSelection, vbOkonly, "Unexpected Error"
    End If
     
    On Error Resume Next
    Dim iRebuildResult
    iRebuildResult = NomGridCtrl1.Rebuild()
     
    If iRebuildResult <> 0 Then
        msgbox "Grid rebuild failed with code " & iRebuildResult, vbOkonly, "Rebuild Error"
    End If
 
End Sub

Clear

The Clear method clears the contents and values of the object.

Syntax

Clear

Example

The following example will clear all values from the GCM Nomination Grid.

1
2
3
Sub Clear()
    NomGridCtrl.Clear
End Sub

Export

The Export method exports the contents of the grid to a temporary CSV file and opens the file with the default spreadsheet viewer for the user to view and save to disk.

Syntax

Export()

Example

The following example exports the data in the GCM Nomination Grid to a CSV file.

1
2
3
4
5
6
7
Sub NomGridCtrl1_EventRefreshComplete()
    Dim This : Set This = NomGridCtrl1
    If bIsExported = False Then
        this.Export
        bIsExported = True
    End If
End Sub

ExportToFile

The ExportToFile method exports the contents of the grid to a specified CSV file.

Syntax

ExportToFile(strExportFileFullPathName As String)

Parameters

Example

The following example exports the data in the GCM Nomination Grid to a CSV file located at C:\GcmExport.csv.

1
2
3
Sub ExportToFileButton_EventClick()
    NomGridCtrl1.ExportToFile "C:\GcmExport.csv"
End Sub

GetCellText

The GetCellText method gets the text of the cell specified by row and column.

Syntax

GetCellText(nRowIndex As Integer, nColumnIndex As Integer) As String

Parameters

Example

The following example returns the text of the cell specified by row and column.

1
strCellText = NomGridCtrl1.GetCellText(1, 0)

GetCellTextByFacility

The GetCellTextByFacility method gets the text of the cell specified by given Facilty and column.

Syntax

GetCellTextByFacility(strFacTag As String, nColumnIndex As Integer) As String

Parameters

Example

The following example gets the text of column 0 for the facility LVL1_1.

1
strCellText = NomGridCtrl1.GetCellTextByFacility("MY_SITE.UIS::LVL1_1", 0)

Print

The Print method prints the contents of the control, grid, or viewer. When this method is called, the Print dialog box is shown to allow configuration.

Syntax

Print()

Example

The following method prints contents of the CygNet GCM Nomination Grid control when a button is pressed.

1
2
3
4
Sub ButtonTool1_EventClick()
    Dim This : Set This = ButtonTool1
    NomGridCtrl.Print
End Sub

Rebuild

The Rebuild method re-reads the Group Service (GRP) hierarchy and Current Value Service (CVS), then redraws the grid and refreshes the data.

Syntax

Rebuild As Integer

Example

1
2
3
4
5
6
Sub NomGridCtrl1_EventInitialize()
    Dim This : Set This = NomGridCtrl1
    this.HistoricalDate = now()
    this.Rebuild
    bIsExported = False
End Sub

Refresh

The Refresh method refreshes the contents of the control from the Current Value Service (CVS).

Syntax

Refresh()

Example

The following example refreshes the CygNet GCM Nomination Grid control when a button is pressed.

1
2
3
4
Sub ButtonTool1_EventClick()
    Dim This : Set This = ButtonTool1
    NomGridCtrl1.Refresh
End Sub

StopAllActivity

The StopAllActivity method stops all work if the grid is building. Call this method when closing the screen.

Syntax

StopAllActivity As Integer

Example

See the example above for ApplyUnitSet.